Skip to main content

Fetch Payment Split

Fetch all configured Payment Splits

Request

GET 'https://apisandbox.delbank.com.br/baas/api/v1/split-payments/configurations'

Headers

NameDescription
x-delbank-api-keyRequired. API key
x-delfinance-account-idRequired. The Delfinance bank account number

Response

On a successful response, here's what you'll receive:

{
"id": 15,
"createdAt": "2025-09-19T20:04:38.112Z",
"updatedAt": "2025-09-19T20:04:38.112Z",
"beneficiaries": [
{
"id": 18,
"splitPaymentConfigurationId": 15,
"ruleAmount": 5,
"ruleType": "PERCENTAGE",
"pixKey": "string",
"bankIspb": "string",
"bankAccountNumber": "string",
"bankAccountBranch": "string",
"holderDocument": "string",
"holderName": "string",
"bankAccountType": "PAYMENT"
}
]
},
{
"id": 16,
"createdAt": "2025-09-19T20:04:38.112Z",
"updatedAt": "2025-09-19T20:04:38.112Z",
"beneficiaries": [
{
"id": 18,
"splitPaymentConfigurationId": 16,
"ruleAmount": 5,
"ruleType": "PERCENTAGE",
"pixKey": "string",
"bankIspb": "string",
"bankAccountNumber": "string",
"bankAccountBranch": "string",
"holderDocument": "string",
"holderName": "string",
"bankAccountType": "PAYMENT"
}
]
}

Fetch configured Payment Split by Id

Request

GET 'https://apisandbox.delbank.com.br/baas/api/v1/split-payments/configurations/{id}'

Headers

NameDescription
x-delbank-api-keyRequired. API key
x-delfinance-account-idRequired. The Delfinance bank account number

Path Parameteres

NameDescription
IdRequired. The Payment Split configuration Id

Response

On a successful response, here's what you'll receive:

{
"id": 15,
"createdAt": "2025-09-19T20:04:38.112Z",
"updatedAt": "2025-09-19T20:04:38.112Z",
"beneficiaries": [
{
"id": 18,
"splitPaymentConfigurationId": 15,
"ruleAmount": 5,
"ruleType": "PERCENTAGE",
"pixKey": "string",
"bankIspb": "string",
"bankAccountNumber": "string",
"bankAccountBranch": "string",
"holderDocument": "string",
"holderName": "string",
"bankAccountType": "PAYMENT"
}
]
}